Documentation Updates - 2025-10-21

This PR updates the documentation based on features merged in the last 24 hours.

Features Documented

• Logs command timeout option (from Add --timeout option to logs command for MCP server timeout prevention #2058)

  • Added --timeout flag documentation
  • Documented 50-second default timeout for MCP server
  • Explained graceful degradation with partial results

• Logs command caching (from Add run summary caching to logs command for faster reprocessing #2066)

  • Documented run_summary.json caching mechanism
  • Explained 10-100x performance improvement for reprocessing
  • Noted CLI version-based cache invalidation

• Audit command parse option (from Add --parse option to audit command #2051)

  • Added --parse flag documentation for generating detailed log.md files

• Audit command URL support (from Add URL parsing support to audit command for cross-repository and GitHub Enterprise auditing #2052)

  • Documented cross-repository auditing via URLs
  • Added GitHub Enterprise URL support examples
  • Listed supported URL patterns (standard, workflow, job URLs)

• MCP server continuation field (from Add continuation field to logs JSON output when timeout is reached #2064)

  • Documented automatic pagination with continuation field
  • Provided JSON response example
  • Explained agent usage pattern for fetching complete data

• MCP server large output handling (from Add automatic file writing for large MCP tool outputs exceeding 16,000 tokens with compact schema descriptions #2060)

  • Documented 16,000 token threshold for automatic file writing
  • Explained file location and naming (/tmp/gh-aw/safe-outputs/)
  • Documented schema description format for arrays, objects, and text

Changes Made

• Updated docs/src/content/docs/tools/cli.md:

  • Added timeout option and caching details to "Log Analysis and Monitoring" section
  • Enhanced audit command documentation with URL support and --parse option

• Updated docs/src/content/docs/tools/mcp-server.md:

  • Added "Logs Tool Features" subsection with timeout/continuation and large output handling

Merged PRs Referenced

• Add run summary caching to logs command for faster reprocessing #2066 - Add run summary caching to logs command for faster reprocessing
• Add continuation field to logs JSON output when timeout is reached #2064 - Add continuation field to logs JSON output when timeout is reached
• Add automatic file writing for large MCP tool outputs exceeding 16,000 tokens with compact schema descriptions #2060 - Add automatic file writing for large MCP tool outputs exceeding 16,000 tokens
• Add --timeout option to logs command for MCP server timeout prevention #2058 - Add --timeout option to logs command for MCP server timeout prevention
• Add URL parsing support to audit command for cross-repository and GitHub Enterprise auditing #2052 - Add URL parsing support to audit command for cross-repository and GitHub Enterprise auditing
• Add --parse option to audit command #2051 - Add --parse option to audit command

Documentation Guidelines Followed

All changes follow the Diátaxis framework as documented in .github/instructions/documentation.instructions.md:

• Used Reference format (information-oriented) for CLI command documentation
• Maintained neutral, technical tone without promotional language
• Used markdown heading syntax consistently
• Included focused code examples with proper syntax highlighting
• Preserved existing documentation structure and style

Notes

The following PRs contained internal improvements or minor fixes that do not require user-facing documentation updates:

• [tidy] Fix struct field alignment in test code #2061, [tidy] Fix JavaScript formatting in Copilot log parsing files #2056 - Code formatting (tidy workflow)
• Update audit-workflows: increase timeouts and always generate discussion reports #2057 - Internal workflow configuration changes
• Add progress indicator to workflow runs fetching spinner #2054 - Progress indicator UI improvement (self-documenting)
• Fix Copilot log parser: accumulate token usage and improve JSON block detection #2050 - Log parser internal improvements
• Fix logs command parameter naming confusion in pagination function #2049 - Internal parameter naming fix
• Add --add-dir arguments (/tmp/, /tmp/gh-aw/, /tmp/gh-aw/agent/) to copilot engine default arguments #2048 - Default argument change (documented in existing sections)
• Clear error patterns: Reduce from 68 to 25 patterns (63% reduction) #2047 - Error pattern reduction (internal)
• feat: Add agent column to logs output and update table header style #2046 - Agent column addition (self-documenting in output)
• Configure GitHub MCP defaults: read-only=true, toolset=default, wildcard tools #2041 - GitHub MCP defaults (internal configuration)
• Fix logs command not finding all runs when no workflow name is specified #2045 - Logs filtering fix (bug fix)
• Bump vite from 7.1.6 to 7.1.11 in /pkg/workflow/js #2043, Bump vite from 6.3.6 to 6.4.1 in /docs #2044 - Dependency updates

AI generated by Daily Documentation Updater